convert overlay vpa enabled from bool to enum #24761
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
huizhifan
requested review from
palma21,
weinong,
alvinli222,
matthchr and
circy9
as code owners
|
Hi, @huizhifan! Thank you for your pull request. To help get your PR merged: Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| managedClusters.json | 2023-06-01(cdc8333) | 2023-05-01(main) |
| managedClusters.json | 2023-06-01(cdc8333) | 2023-05-02-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots' removed or restructured? Old: aks/preview/2023-05-02-preview/managedClusters.json#L2603:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots' removed or restructured? Old: aks/preview/2023-05-02-preview/managedClusters.json#L2642:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}' removed or restructured? Old: aks/preview/2023-05-02-preview/managedClusters.json#L2684:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles' removed or restructured? Old: aks/preview/2023-05-02-preview/managedClusters.json#L2870:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings' removed or restructured? Old: aks/preview/2023-05-02-preview/managedClusters.json#L2912:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}' removed or restructured? Old: aks/preview/2023-05-02-preview/managedClusters.json#L2957:5 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolNetworkProfile' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NodePublicIPTags' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterNodeResourceGroupProfile' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'UpgradeOverrideSettings' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ClusterUpgradeSettings' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolWindowsProfile' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterIngressProfile' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterIngressProfileWebAppRouting' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileNodeRestriction' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileCustomCATrustCertificates' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSnapshot' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSnapshotProperties' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterPropertiesForSnapshot' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkProfileForSnapshot' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPlugin' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPluginMode' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPolicy' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkMode' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkDataplane' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkMonitoring' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'LoadBalancerSku' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'CapacityReservationGroupID' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'TrustedAccessRoleBindingProperties' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
|
| The new version is missing a definition that was found in the old version. Was 'TrustedAccessRoleBinding' removed or renamed? New: aks/stable/2023-06-01/managedClusters.json#L2567:3 Old: aks/preview/2023-05-02-preview/managedClusters.json#L3104:3 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-06 | package-2023-06(cdc8333) | package-2023-06(dev-containerservice-Microsoft.ContainerService-2023-06-01) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/stable/2023-06-01/managedClusters.json#L52 |
|
Operations API path must follow the schema provided in the common types. Location: aks/stable/2023-06-01/managedClusters.json#L53 |
|
Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version. Location: aks/stable/2023-06-01/managedClusters.json#L80 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/stable/2023-06-01/managedClusters.json#L103 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/stable/2023-06-01/managedClusters.json#L137 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/stable/2023-06-01/managedClusters.json#L260 |
|
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/stable/2023-06-01/managedClusters.json#L278 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2023-06-01/managedClusters.json#L336 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2023-06-01/managedClusters.json#L381 |
|
format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2023-06-01/managedClusters.json#L381 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2023-06-01/managedClusters.json#L429 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-06-01/managedClusters.json#L553 |
|
LRO PATCH must have 200 and 202 return codes. Location: aks/stable/2023-06-01/managedClusters.json#L633 |
|
The patch operation body parameter schema should contain property 'identity'. Location: aks/stable/2023-06-01/managedClusters.json#L652 |
|
The patch operation body parameter schema should contain property 'sku'. Location: aks/stable/2023-06-01/managedClusters.json#L652 |
|
The async patch operation should return 202. Location: aks/stable/2023-06-01/managedClusters.json#L662 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-06-01/managedClusters.json#L672 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-06-01/managedClusters.json#L719 |
|
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/stable/2023-06-01/managedClusters.json#L779 |
|
A LRO POST operation must have both 200 & 202 return codes. Location: aks/stable/2023-06-01/managedClusters.json#L949 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-06-01/managedClusters.json#L1000 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-06-01/managedClusters.json#L1163 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-06-01/managedClusters.json#L1265 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/stable/2023-06-01/managedClusters.json#L1311 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'AgentPools' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: aks/stable/2023-06-01/managedClusters.json#L1334 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/stable/2023-06-01/managedClusters.json#L1354 |
|
200 response for a LRO POST operation must have a response schema specified. Location: aks/stable/2023-06-01/managedClusters.json#L1373 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-06-01/managedClusters.json#L1419 |
|
200 response for a LRO POST operation must have a response schema specified. Location: aks/stable/2023-06-01/managedClusters.json#L1435 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-06-01/managedClusters.json#L1482 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
huizhifan
changed the title
This was referenced Jul 11, 2023
matthchr
requested changes
Jul 11, 2023
| "true", | ||
| "false" | ||
| ], | ||
| "x-ms-enum": { |
There was a problem hiding this comment.
IMO there is no value in doing this in an enum. Just tell the Swagger reviewer we have a pattern of using boolean for addon enablement and they will let us through.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links